MetricModel

database_builder.MetricModel()

Represents a metric configuration for infometric analysis.

Attributes

name : str

The short name of the metric.

long_name : str | None, default=None

The long descriptive name of the metric. If not provided, defaults to name.

show_in_metrics_table : bool | None, default=True

Indicates whether the metric should be displayed in the metrics table.

show_in_map : bool | None, default=True

Indicates whether the metric should be displayed on the map.

description : str | None, default=None

A detailed description of the metric. If not provided, defaults to name.

select : str

The SQL select statement or expression for the metric.

filter : str | None, default=""

An optional SQL filter to apply to the metric. Defaults to no filter.

Validation

If long_name or description are None, they will be set to the value of name.

Back to top